home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / sys / StringSnip.readme < prev   
Text File  |  1999-03-02  |  11KB  |  313 lines
  1. Short:    Much better editing features in string gadgets
  2. Author:   thor@einstein.math.tu-berlin.de (Thomas Richter)
  3. Uploader: thor@einstein.math.tu-berlin.de
  4. Version:  2.02
  5. Type:     util/sys
  6. Requires: Os 2.04, optionally ViNCEd.
  7.  
  8. _____________________________________________________________________________
  9.  
  10. New in release 2.02:
  11.  
  12.     - The NumLock function was erraneously bound to Alt-Ü on german
  13.       keyboards. Never thrust a Data-Becker book, especially when
  14.       looking up key-codes.
  15.  
  16. New in release 2.01.1:
  17.  
  18.     - Included a sample preferences file for those people that don't
  19.       read ReadMes. (-;
  20.  
  21. New in release 2.01:
  22.  
  23.     - Almost a complete rewrite, fully configurable with ViNCEd style
  24.       preferences (vnc.library required).
  25.     - Includes now TAB expansions and much more editor commands.
  26. _____________________________________________________________________________
  27.  
  28.  
  29. The following table shows the default configuration for string gadget hooks:
  30.  
  31. Alt+Cursor keys:    Move to beginning of next/previous word
  32. Alt+Ctrl+Cursor keys:    Move to beginning of next/previous path component
  33. Shift+Cursor keys:    Move to start/end of the contents.
  34. Alt+Cursor keys:    ditto.
  35. Alt+Del:        Clear the contents.
  36. Shift+Del:        ditto.
  37. ALT+Backspace:        Erase to the beginning of the word under the cursor
  38. Shift+Alt+Del:        Erase text behind the cursor
  39. Shift+Alt+BS:        Erase text before the cursor position
  40. Amiga+X:        Cut the contents of the gadget to the clipboard
  41. Amiga+C:        Copy the contents to the clipboard
  42. Amiga+V:        Insert the clipboard contents into the gadget
  43. Shift+Amiga+V:        Replace the string gadget contents by the clipboard
  44. Aniga+Q:        Undo-operation
  45. Ctrl+Tab:        TAB expansion
  46. Ctrl+Shift+Tab:        TAB expansion backwards
  47. Commodore-key:        Turn off the extended editing features temporary
  48.  
  49.  
  50. The configuration is, however, fully adjustable with the SetVNC program
  51. of the "ViNCEd" package, see below for details.
  52.  
  53. The TAB expansion is a "cut down" version of the ViNCEd style expansion
  54. mechanism without a double-TAB requester, without the complete command
  55. path search and without a TAB expansion cache.
  56. Please note that string gadget does not come with a "natural" directory the 
  57. TAB expansion should search in, hence the path to be expanded must be either
  58. absolute or relative to the boot volume, i.e. SYS:
  59.  
  60. (This file is actually a part of the ViNCEd distribution. See 
  61. util/shell/ViNCEd.lha for the complete archive).
  62.  
  63.  
  64. Installation:
  65.     Copy to your C: drawer.
  66.  
  67.     StringSnip install    To install the extended editing features
  68.     StringSnip remove    To remove it again.
  69.  
  70. Additionally:    
  71.     Copy the demo prefs file below to ENVARC:StringSnip.prefs and 
  72.     add the line
  73.  
  74.     StringSnip PREFS ENV:StringSnip.prefs INSTALL
  75. _____________________________________________________________________________
  76.  
  77. Extended options, full synopsis:
  78.  
  79. StringSnip INSTALL/S,REMOVE/S,PREFS/K,HELP/S
  80.  
  81.  
  82. INSTALL/S            Installs the enhanced string edit hook
  83.                 or replaces a previously installed 
  84.                 "StringSnip" copy.
  85.                 This is the default operation.
  86.  
  87. REMOVE/S            Remove the StringSnip hook.
  88.  
  89. PREFS/K                Specifies a file name where the preferences
  90.                 should be taken from. This is a text based
  91.                 ViNCEd-compatible preferences file. It
  92.                 should be created by the "SetVNC" program
  93.                 and should be placed somehwere in the ENV:
  94.                 drawer.
  95.                 THIS OPTION REQUIRES the vnc.library, i.e.
  96.                 ViNCEd must have been installed.
  97.  
  98. HELP/S                Prints a tiny overview about the command line
  99.                 options.
  100. _____________________________________________________________________________
  101.  
  102. The preferences file: 
  103.  
  104. It is recommended that you use the "SetVNC" program of the ViNCEd package
  105. to generate this file, as the vnc.library is required anyways to read it.
  106.  
  107. As last resort, an ASCII editor is enough to edit this file, though.
  108.  
  109. The file is a listing of options, followed by an "=" ("equals") sign,
  110. followed by the value you want to set the option to. This must be "on"
  111. or "off" for boolean options, a number for numerical or a key specification
  112. for the keyboard configuration options. Commands must be introduced by a
  113. semicolon.
  114.  
  115. Here's a list of the options that are meaningfull to StringSnip. The lines
  116. below could be cut out and written directly to a file, for example to
  117. ENVARC:StringSnip.prefs.
  118.  
  119. ___________cut here__________________________________________________________
  120.  
  121. WRAP=off        
  122. ;whether the TAB expansion wraps around or not.
  123.  
  124. ;TAB expansion settings:
  125. ;These are priorities how the list of found nodes are sorted and in
  126. ;which order they appear. The list of found matches can be cycled thru
  127. ;with the TAB expansion keys, as in ViNCEd.
  128.  
  129. TAB_FILE_PRI=0        
  130. ;priority of non-executable non-script files
  131. TAB_EXEC_PRI=2        
  132. ;priority of executables.
  133. TAB_SCRIPT_PRI=1    
  134. ;priority of script files.
  135. TAB_INFO_PRI=-10    
  136. ;priority of icons
  137. TAB_DEVICE_PRI=-2    
  138. ;of devices
  139. TAB_ASSIGN_PRI=-2    
  140. ;of assigns (logical devices)
  141. TAB_VOLUME_PRI=-2    
  142. ;of volume names
  143. TAB_DIRECTORY_PRI=3    
  144. ;of directories
  145. TAB_FULLEXPAND=off    
  146. ;should the first TAB expand the file completely?
  147.  
  148.  
  149. ;Keyboard:
  150. ;These are one or more qualifiers, i.e.
  151. ; Alt, Shift for either shift or alt key, RAmiga, LAmiga, RShift, LShift,
  152. ; RAlt, RAlt for the right/left modifier keys, "Num" if numlock is "on".
  153. ; The numlock is a special modifier that is toggled by an additional key
  154. ; to be set up here, it is completely unrelated to the "numeric keypad"
  155. ;and a key name, as "Left" "Right" for the cursor keys or
  156. ;a keyboard code, or an ASCII value enclosed in single quotes if the
  157. ;key should be matched on an ASCII string and not on a physical key.
  158. ;Details about this again in the ViNCEd guide.
  159. ;
  160. CURSOR_LEFT=Left
  161. CURSOR_RIGHT=Right        
  162. ;guess what...
  163. HALF_SCREEN_LEFT=Shift Left    
  164. ;moves one string gadget width
  165. HALF_SCREEN_RIGHT=Shift Right    
  166. ;to the left/right (not used by default)
  167. TO_LEFT_BORDER=Ctrl Left
  168. TO_RIGHT_BORDER=Ctrl Right    
  169. ;moves to the boundary
  170. PREV_WORD=Alt Left
  171. NEXT_WORD=Alt Right        
  172. ;moves word-wise
  173. PREV_COMPONENT=Ctrl Alt Left
  174. NEXT_COMPONENT=Ctrl Alt Right    
  175. ;moves path-component-wise
  176. CURSOR_LEFT=Num Num4
  177. CURSOR_RIGHT=Num Num6        
  178. ;more than one definition is allowed!
  179. TO_LEFT_BORDER=Ctrl Left
  180. TO_RIGHT_BORDER=Ctrl Right
  181. SEND_INPUTS=Return        
  182. ;completes the input
  183. INSERT_^J=Shift Alt Return    
  184. ;inserts a Ctrl-J.
  185. TAB_FORWARDS=Tab
  186. TAB_BACKWARDS=Shift Tab        
  187. ;TAB cycling
  188. EXPAND_PATH=Ctrl Tab
  189. EXPAND_BACKWARDS=Ctrl Shift Tab    
  190. ;TAB expansion
  191. DELETE_FORWARDS=Del        
  192. ;the "Delete" function
  193. DELETE_BACKWARDS=Backspace    
  194. ;the "Backspace" function
  195. DELETE_FULL_LINE=Shift Del    
  196. ;delete all
  197. DELETE_WORD_FWDS=Shift Backspace
  198. DELETE_WORD_BKWDS=Alt Backspace    
  199. ;one word, backwards
  200. DELETE_COMPONENT_FWDS=Ctrl Alt Del
  201. DELETE_COMPONENT_BKWDS=Ctrl Alt Backspace
  202. DELETE_END_OF_LINE=Shift Alt Del
  203. DELETE_START_OF_LINE=Shift Alt Backspace
  204. ;the next are the standard clipboard functions
  205. CUT=RAmiga x            
  206. COPY=RAmiga c
  207. PASTE=RAmiga v
  208. TOGGLE_NUMLOCK=Alt Num[        
  209. ;Num[ is the '[' key on the numpad, this toggles the NumLock qualifier.
  210. YANK=RAmiga q            
  211. ;this is the intuition style "undo"
  212. HELP=Help            
  213. ;the HELP function, if used by the program
  214. INSERT_CSI=Alt Esc        
  215. ;inserts 0x9B
  216. INSERT_ESC=Shift Esc        
  217. ;inserts 0x1B
  218.  
  219. _____________________________________________________________________________
  220.  
  221.                          The THOR-Software Licence (v2, 24th June 1998)
  222.  
  223.  
  224. This License applies to the computer program known as "StringSnip".
  225. The "Program", below, refers to such program. The "Archive" refers to the 
  226. package of distribution, as prepared by the author of the Program, 
  227. Thomas Richter. Each licensee is addressed as "you".
  228.  
  229.  
  230.  
  231. The Program and the data in the archive are freely distributable
  232. under the restrictions stated below, but are also Copyright (c)
  233. Thomas Richter.
  234.  
  235. Distribution of the Program, the Archive and the data in the Archive by a
  236. commercial organization without written permission from the author to any
  237. third party is prohibited if any payment is made in connection with such
  238. distribution, whether directly (as in payment for a copy of the Program) or
  239. indirectly (as in payment for some service related to the Program, or
  240. payment for some product or service that includes a copy of the Program
  241. "without charge"; these are only examples, and not an exhaustive enumeration
  242. of prohibited activities).
  243.  
  244.  
  245. However, the following methods of distribution
  246. involving payment shall not in and of themselves be a violation of this
  247. restriction:
  248.  
  249.  
  250. (i) Posting the Program on a public access information storage and
  251. retrieval service for which a fee is received for retrieving information
  252. (such as an on-line service), provided that the fee is not
  253. content-dependent (i.e., the fee would be the same for retrieving the same
  254. volume of information consisting of random data).
  255.  
  256.  
  257. (ii) Distributing the Program on a CD-ROM, provided that
  258.  
  259. a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
  260. especially this licence agreement;
  261.  
  262. b) the CD-ROM is made available to the public for a nominal fee only,
  263.  
  264. c) a copy of the CD is made available to the author for free except for
  265. shipment costs, and
  266.  
  267. d) provided further that all information on such CD-ROM is redistributable
  268. for non-commercial purposes without charge.
  269.  
  270.  
  271. Redistribution of a modified version of the Archive, the Program or the
  272. contents of the Archive is prohibited in any way, by any organization,
  273. regardless whether commercial or non-commercial. Everything must be kept
  274. together, in original and unmodified form.
  275.  
  276.  
  277.  
  278.  
  279. Limitations.
  280.  
  281.  
  282. THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
  283. WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  284. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  285. PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
  286. RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
  287. THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  288. SERVICING, REPAIR OR CORRECTION.
  289.  
  290.  
  291. IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
  292. AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
  293. LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.
  294.  
  295.  
  296.                                                         Thomas Richter
  297.  
  298. _____________________________________________________________________________
  299.  
  300. Thomas,
  301.     February 1999
  302.  
  303.  
  304. ============================= Archive contents =============================
  305.  
  306. Original  Packed Ratio    Date     Time    Name
  307. -------- ------- ----- --------- --------  -------------
  308.     9724    5864 39.6% 16-Feb-99 21:07:12 +StringSnip
  309.     2981    1426 52.1% 23-Jan-99 18:44:30 +StringSnip.prefs
  310.    10206    4255 58.3% 16-Feb-99 21:08:50 +StringSnip.readme
  311. -------- ------- ----- --------- --------
  312.    22911   11545 49.6% 22-Feb-99 19:32:58   3 files
  313.